Skip to content

docs(examples): standardize tutorial, notebooks, and root examples - #1777

Merged
rafvasq merged 2 commits into
generative-computing:mainfrom
rafvasq:docs/tutorials-notebooks-root-standardize
Nov 2, 2026
Merged

docs(examples): standardize tutorial, notebooks, and root examples#1777
rafvasq merged 2 commits into
generative-computing:mainfrom
rafvasq:docs/tutorials-notebooks-root-standardize

Conversation

@rafvasq

@rafvasq rafvasq commented Oct 29, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Pull Request

Issue

Towards #1746

Description

Standardizes tutorial/, notebooks/, the root docs/examples/README.md, and the root example scripts.

Docstrings

  • Kept the original titles and descriptions. Scripts that had no docstring use their README description as the title.
  • Added Prerequisites: (where they're required) and Usage: blocks.

READMEs

  • tutorial/ and notebooks/: the file lists are now ## Examples tables using the original descriptions, with a "See Also" section linking the two directories and the first tutorial.
  • Removed sections:
    • tutorial/README.md: "Running the Examples", "Key Concepts Covered", "Differences from Notebooks", "Relationship to Notebooks".
    • notebooks/README.md: "Benefits of Notebooks", "Corresponding Python Files", "Tips".
    • Run instructions now live in each script's Usage: block. The .py ↔ .ipynb mapping can be read from the two ## Examples tables.

Other fixes

  • Root README.md:
    • Added the missing sampling/ and primitives/ entries.
    • Fixed the tutorial/simple_email.py link, which was pointing at the directory.
  • tutorial/table_mobject.py: added the missing uv pip install pandas prerequisite.
  • tutorial/document_mobject.py: removed an unused IBM_GRANITE_4_HYBRID_MICRO import.

Testing

  • Tests added to the respective file if code was changed
  • New code has 100% coverage if code was added
  • Ensure existing tests and github automation passes (a maintainer will kick off the github automation when the rest of the PR is populated)

Attribution

  • AI coding assistants used

Adding a new component, requirement, sampling strategy, or tool?

If your PR adds or modifies one of the types below, check the matching box. A checklist of type-specific review items will be posted as a comment.

  • Component
  • Requirement
  • Sampling Strategy
  • Tool

NOTE: Please ensure you have an issue that has been acknowledged by a core contributor and routed you to open a pull request against this repository. Otherwise, please open an issue before continuing with this pull request.

@rafvasq
docs(examples): standardize tutorial, notebooks, and root examples
7fbfbfd 
Signed-off-by: Rafael Vasquez <rafvasq21@gmail.com>
Assisted-by: IBM Bob
@rafvasq
rafvasq requested a review from a team as a code owner October 29, 2026 15:59
@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Oct 29, 2026
@rafvasq rafvasq mentioned this pull request Oct 29, 2026
Open
planetf1
planetf1 reviewed Oct 30, 2026
View reviewed changes

@planetf1 planetf1 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Docs-only change; three small notes inline. CI is green at 7fbfbfd8a and example collection is unchanged (the same 15 items as main).

The README section removals match #1746. Nothing project-specific is lost: run instructions moved into each script's Usage: block, and the .py ↔ .ipynb mapping is now derivable from the two tables for all nine files.

Separately, not for this PR: README.md:278 still shows the older python <script> / uv run <script> form.

Comment thread docs/examples/tutorial/README.md Resolved
Comment thread docs/examples/README.md Resolved
Comment thread docs/examples/tutorial/simple_email.py Resolved
@rafvasq
docs(examples): address review feedback on tutorial and root README
156e064 
Remove stale Granite 4 Micro download comment from simple_email.py and point the sentiment_classifier.py link at the script.

Assisted-by: IBM Bob
Signed-off-by: Rafael Vasquez <rafvasq21@gmail.com>
@rafvasq
rafvasq requested a review from planetf1 October 30, 2026 18:50
planetf1
planetf1 approved these changes Nov 2, 2026
View reviewed changes

@planetf1 planetf1 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks — all three points are addressed at 156e064: the PR body lists the removed README sections, the sentiment_classifier.py link now points at the script, and the stale Granite download comment is gone from simple_email.py. Example markers are untouched. LGTM.

@rafvasq
rafvasq added this pull request to the merge queue Nov 2, 2026
Merged via the queue into generative-computing:main with commit 2e2d08b Nov 2, 2026
14 checks passed
@rafvasq
rafvasq deleted the docs/tutorials-notebooks-root-standardize branch November 2, 2026 20:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@planetf1 planetf1 planetf1 approved these changes
@markstur markstur Awaiting requested review from markstur markstur is a code owner automatically assigned from generative-computing/mellea-maintainers
@ajbozarth ajbozarth Awaiting requested review from ajbozarth ajbozarth is a code owner automatically assigned from generative-computing/mellea-maintainers

Assignees

No one assigned

Labels

documentation Improvements or additions to documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@rafvasq @planetf1